Skip to main content

SimpleStarRegionInfo


BeaconCount

The amount of beacons in the region at the time of the scan. It is of the type number. It is read-only, it cannot be assigned to.


Name

The name of the region. It is of the type string. It is read-only, it cannot be assigned to.


Size

The visual size of the star. It ranges between 2000 and 6000. It increments by 1. It is of the type number. It is read-only, it cannot be assigned to.


SubType

The type of the star, such as Red, Orange, Yellow, etc. It is of the type StarType. It is read-only, it cannot be assigned to.


Type

The type of the region. It is always the string Star. It is read-only, it cannot be assigned to.

Luau Type

This is the luau type for SimpleStarRegionInfo. It may help clear up mistranslations from the raw data to the wiki page (as it is an automatic process).

export type SimpleStarRegionInfo = {
read BeaconCount: number,
read Type: "Star",
read Name: string,
read SubType: StarType,
read Size: number,
}